home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / gnustuff / tos / bison / bisn119s.zoo / bison.info-2 < prev    next >
Encoding:
GNU Info File  |  1992-09-05  |  49.7 KB  |  1,386 lines
  1. This is Info file bison.info, produced by Makeinfo-1.47 from the input
  2. file /home/gd/gnu/bison/bison.texinfo.
  3.  
  4.    This file documents the Bison parser generator.
  5.  
  6.    Copyright (C) 1988, 1989, 1990 Free Software Foundation, Inc.
  7.  
  8.    Permission is granted to make and distribute verbatim copies of this
  9. manual provided the copyright notice and this permission notice are
  10. preserved on all copies.
  11.  
  12.    Permission is granted to copy and distribute modified versions of
  13. this manual under the conditions for verbatim copying, provided also
  14. that the sections entitled "GNU General Public License" and "Conditions
  15. for Using Bison" are included exactly as in the original, and provided
  16. that the entire resulting derived work is distributed under the terms
  17. of a permission notice identical to this one.
  18.  
  19.    Permission is granted to copy and distribute translations of this
  20. manual into another language, under the above conditions for modified
  21. versions, except that the sections entitled "GNU General Public
  22. License", "Conditions for Using Bison" and this permission notice may be
  23. included in translations approved by the Free Software Foundation
  24. instead of in the original English.
  25.  
  27. File: bison.info,  Node: Rpcalc Lexer,  Next: Rpcalc Main,  Prev: Rpcalc Expr,  Up: RPN Calc
  28.  
  29. The `rpcalc' Lexical Analyzer
  30. -----------------------------
  31.  
  32.    The lexical analyzer's job is low-level parsing: converting
  33. characters or sequences of characters into tokens.  The Bison parser
  34. gets its tokens by calling the lexical analyzer.  *Note Lexical::.
  35.  
  36.    Only a simple lexical analyzer is needed for the RPN calculator. 
  37. This lexical analyzer skips blanks and tabs, then reads in numbers as
  38. `double' and returns them as `NUM' tokens.  Any other character that
  39. isn't part of a number is a separate token.  Note that the token-code
  40. for such a single-character token is the character itself.
  41.  
  42.    The return value of the lexical analyzer function is a numeric code
  43. which represents a token type.  The same text used in Bison rules to
  44. stand for this token type is also a C expression for the numeric code
  45. for the type. This works in two ways.  If the token type is a character
  46. literal, then its numeric code is the ASCII code for that character;
  47. you can use the same character literal in the lexical analyzer to
  48. express the number.  If the token type is an identifier, that
  49. identifier is defined by Bison as a C macro whose definition is the
  50. appropriate number.  In this example, therefore, `NUM' becomes a macro
  51. for `yylex' to use.
  52.  
  53.    The semantic value of the token (if it has one) is stored into the
  54. global variable `yylval', which is where the Bison parser will look for
  55. it. (The C data type of `yylval' is `YYSTYPE', which was defined at the
  56. beginning of the grammar; *note Rpcalc Decls::..)
  57.  
  58.    A token type code of zero is returned if the end-of-file is
  59. encountered. (Bison recognizes any nonpositive value as indicating the
  60. end of the input.)
  61.  
  62.    Here is the code for the lexical analyzer:
  63.  
  64.      /* Lexical analyzer returns a double floating point
  65.         number on the stack and the token NUM, or the ASCII
  66.         character read if not a number.  Skips all blanks
  67.         and tabs, returns 0 for EOF. */
  68.      
  69.      #include <ctype.h>
  70.      
  71.      yylex ()
  72.      {
  73.        int c;
  74.      
  75.        /* skip white space  */
  76.        while ((c = getchar ()) == ' ' || c == '\t')
  77.          ;
  78.        /* process numbers   */
  79.        if (c == '.' || isdigit (c))
  80.          {
  81.            ungetc (c, stdin);
  82.            scanf ("%lf", &yylval);
  83.            return NUM;
  84.          }
  85.        /* return end-of-file  */
  86.        if (c == EOF)
  87.          return 0;
  88.        /* return single chars */
  89.        return c;
  90.      }
  91.  
  93. File: bison.info,  Node: Rpcalc Main,  Next: Rpcalc Error,  Prev: Rpcalc Lexer,  Up: RPN Calc
  94.  
  95. The Controlling Function
  96. ------------------------
  97.  
  98.    In keeping with the spirit of this example, the controlling function
  99. is kept to the bare minimum.  The only requirement is that it call
  100. `yyparse' to start the process of parsing.
  101.  
  102.      main ()
  103.      {
  104.        yyparse ();
  105.      }
  106.  
  108. File: bison.info,  Node: Rpcalc Error,  Next: Rpcalc Gen,  Prev: Rpcalc Main,  Up: RPN Calc
  109.  
  110. The Error Reporting Routine
  111. ---------------------------
  112.  
  113.    When `yyparse' detects a syntax error, it calls the error reporting
  114. function `yyerror' to print an error message (usually but not always
  115. `"parse error"').  It is up to the programmer to supply `yyerror'
  116. (*note Interface::.), so here is the definition we will use:
  117.  
  118.      #include <stdio.h>
  119.      
  120.      yyerror (s)  /* Called by yyparse on error */
  121.           char *s;
  122.      {
  123.        printf ("%s\n", s);
  124.      }
  125.  
  126.    After `yyerror' returns, the Bison parser may recover from the error
  127. and continue parsing if the grammar contains a suitable error rule
  128. (*note Error Recovery::.).  Otherwise, `yyparse' returns nonzero.  We
  129. have not written any error rules in this example, so any invalid input
  130. will cause the calculator program to exit.  This is not clean behavior
  131. for a real calculator, but it is adequate in the first example.
  132.  
  134. File: bison.info,  Node: Rpcalc Gen,  Next: Rpcalc Compile,  Prev: Rpcalc Error,  Up: RPN Calc
  135.  
  136. Running Bison to Make the Parser
  137. --------------------------------
  138.  
  139.    Before running Bison to produce a parser, we need to decide how to
  140. arrange all the source code in one or more source files.  For such a
  141. simple example, the easiest thing is to put everything in one file. 
  142. The definitions of `yylex', `yyerror' and `main' go at the end, in the
  143. "additional C code" section of the file (*note Grammar Layout::.).
  144.  
  145.    For a large project, you would probably have several source files,
  146. and use `make' to arrange to recompile them.
  147.  
  148.    With all the source in a single file, you use the following command
  149. to convert it into a parser file:
  150.  
  151.      bison FILE_NAME.y
  152.  
  153. In this example the file was called `rpcalc.y' (for "Reverse Polish
  154. CALCulator").  Bison produces a file named `FILE_NAME.tab.c', removing
  155. the `.y' from the original file name. The file output by Bison contains
  156. the source code for `yyparse'.  The additional functions in the input
  157. file (`yylex', `yyerror' and `main') are copied verbatim to the output.
  158.  
  160. File: bison.info,  Node: Rpcalc Compile,  Prev: Rpcalc Gen,  Up: RPN Calc
  161.  
  162. Compiling the Parser File
  163. -------------------------
  164.  
  165.    Here is how to compile and run the parser file:
  166.  
  167.      # List files in current directory.
  168.      % ls
  169.      rpcalc.tab.c  rpcalc.y
  170.      
  171.      # Compile the Bison parser.
  172.      # `-lm' tells compiler to search math library for `pow'.
  173.      % cc rpcalc.tab.c -lm -o rpcalc
  174.      
  175.      # List files again.
  176.      % ls
  177.      rpcalc  rpcalc.tab.c  rpcalc.y
  178.  
  179.    The file `rpcalc' now contains the executable code.  Here is an
  180. example session using `rpcalc'.
  181.  
  182.      % rpcalc
  183.      4 9 +
  184.      13
  185.      3 7 + 3 4 5 *+-
  186.      -13
  187.      3 7 + 3 4 5 * + - n              Note the unary minus, `n'
  188.      13
  189.      5 6 / 4 n +
  190.      -3.166666667
  191.      3 4 ^                            Exponentiation
  192.      81
  193.      ^D                               End-of-file indicator
  194.      %
  195.  
  197. File: bison.info,  Node: Infix Calc,  Next: Simple Error Recovery,  Prev: RPN Calc,  Up: Examples
  198.  
  199. Infix Notation Calculator: `calc'
  200. =================================
  201.  
  202.    We now modify rpcalc to handle infix operators instead of postfix. 
  203. Infix notation involves the concept of operator precedence and the need
  204. for parentheses nested to arbitrary depth.  Here is the Bison code for
  205. `calc.y', an infix desk-top calculator.
  206.  
  207.      /* Infix notation calculator--calc */
  208.      
  209.      %{
  210.      #define YYSTYPE double
  211.      #include <math.h>
  212.      %}
  213.      
  214.      /* BISON Declarations */
  215.      %token NUM
  216.      %left '-' '+'
  217.      %left '*' '/'
  218.      %left NEG     /* negation--unary minus */
  219.      %right '^'    /* exponentiation        */
  220.      
  221.      /* Grammar follows */
  222.      %%
  223.      input:    /* empty string */
  224.              | input line
  225.      ;
  226.      
  227.      line:     '\n'
  228.              | exp '\n'  { printf ("\t%.10g\n", $1); }
  229.      ;
  230.      
  231.      exp:      NUM                { $$ = $1;         }
  232.              | exp '+' exp        { $$ = $1 + $3;    }
  233.              | exp '-' exp        { $$ = $1 - $3;    }
  234.              | exp '*' exp        { $$ = $1 * $3;    }
  235.              | exp '/' exp        { $$ = $1 / $3;    }
  236.              | '-' exp  %prec NEG { $$ = -$2;        }
  237.              | exp '^' exp        { $$ = pow ($1, $3); }
  238.              | '(' exp ')'        { $$ = $2;         }
  239.      ;
  240.      %%
  241.  
  242. The functions `yylex', `yyerror' and `main' can be the same as before.
  243.  
  244.    There are two important new features shown in this code.
  245.  
  246.    In the second section (Bison declarations), `%left' declares token
  247. types and says they are left-associative operators.  The declarations
  248. `%left' and `%right' (right associativity) take the place of `%token'
  249. which is used to declare a token type name without associativity. 
  250. (These tokens are single-character literals, which ordinarily don't
  251. need to be declared.  We declare them here to specify the
  252. associativity.)
  253.  
  254.    Operator precedence is determined by the line ordering of the
  255. declarations; the higher the line number of the declaration (lower on
  256. the page or screen), the higher the precedence.  Hence, exponentiation
  257. has the highest precedence, unary minus (`NEG') is next, followed by
  258. `*' and `/', and so on.  *Note Precedence::.
  259.  
  260.    The other important new feature is the `%prec' in the grammar section
  261. for the unary minus operator.  The `%prec' simply instructs Bison that
  262. the rule `| '-' exp' has the same precedence as `NEG'--in this case the
  263. next-to-highest.  *Note Contextual Precedence::.
  264.  
  265.    Here is a sample run of `calc.y':
  266.  
  267.      % calc
  268.      4 + 4.5 - (34/(8*3+-3))
  269.      6.880952381
  270.      -56 + 2
  271.      -54
  272.      3 ^ 2
  273.      9
  274.  
  276. File: bison.info,  Node: Simple Error Recovery,  Next: Multi-function Calc,  Prev: Infix Calc,  Up: Examples
  277.  
  278. Simple Error Recovery
  279. =====================
  280.  
  281.    Up to this point, this manual has not addressed the issue of "error
  282. recovery"--how to continue parsing after the parser detects a syntax
  283. error.  All we have handled is error reporting with `yyerror'.  Recall
  284. that by default `yyparse' returns after calling `yyerror'.  This means
  285. that an erroneous input line causes the calculator program to exit. Now
  286. we show how to rectify this deficiency.
  287.  
  288.    The Bison language itself includes the reserved word `error', which
  289. may be included in the grammar rules.  In the example below it has been
  290. added to one of the alternatives for `line':
  291.  
  292.      line:     '\n'
  293.              | exp '\n'   { printf ("\t%.10g\n", $1); }
  294.              | error '\n' { yyerrok;                  }
  295.      ;
  296.  
  297.    This addition to the grammar allows for simple error recovery in the
  298. event of a parse error.  If an expression that cannot be evaluated is
  299. read, the error will be recognized by the third rule for `line', and
  300. parsing will continue.  (The `yyerror' function is still called upon to
  301. print its message as well.)  The action executes the statement
  302. `yyerrok', a macro defined automatically by Bison; its meaning is that
  303. error recovery is complete (*note Error Recovery::.).  Note the
  304. difference between `yyerrok' and `yyerror'; neither one is a misprint.
  305.  
  306.    This form of error recovery deals with syntax errors.  There are
  307. other kinds of errors; for example, division by zero, which raises an
  308. exception signal that is normally fatal.  A real calculator program
  309. must handle this signal and use `longjmp' to return to `main' and
  310. resume parsing input lines; it would also have to discard the rest of
  311. the current line of input.  We won't discuss this issue further because
  312. it is not specific to Bison programs.
  313.  
  315. File: bison.info,  Node: Multi-function Calc,  Next: Exercises,  Prev: Simple Error Recovery,  Up: Examples
  316.  
  317. Multi-Function Calculator: `mfcalc'
  318. ===================================
  319.  
  320.    Now that the basics of Bison have been discussed, it is time to move
  321. on to a more advanced problem.  The above calculators provided only five
  322. functions, `+', `-', `*', `/' and `^'.  It would be nice to have a
  323. calculator that provides other mathematical functions such as `sin',
  324. `cos', etc.
  325.  
  326.    It is easy to add new operators to the infix calculator as long as
  327. they are only single-character literals.  The lexical analyzer `yylex'
  328. passes back all non-number characters as tokens, so new grammar rules
  329. suffice for adding a new operator.  But we want something more
  330. flexible: built-in functions whose syntax has this form:
  331.  
  332.      FUNCTION_NAME (ARGUMENT)
  333.  
  334. At the same time, we will add memory to the calculator, by allowing you
  335. to create named variables, store values in them, and use them later.
  336. Here is a sample session with the multi-function calculator:
  337.  
  338.      % acalc
  339.      pi = 3.141592653589
  340.      3.1415926536
  341.      sin(pi)
  342.      0.0000000000
  343.      alpha = beta1 = 2.3
  344.      2.3000000000
  345.      alpha
  346.      2.3000000000
  347.      ln(alpha)
  348.      0.8329091229
  349.      exp(ln(beta1))
  350.      2.3000000000
  351.      %
  352.  
  353.    Note that multiple assignment and nested function calls are
  354. permitted.
  355.  
  356. * Menu:
  357.  
  358. * Decl: Mfcalc Decl.     Bison declarations for multi-function calculator.
  359. * Rules: Mfcalc Rules.   Grammar rules for the calculator.
  360. * Symtab: Mfcalc Symtab. Symbol table management subroutines.
  361.  
  363. File: bison.info,  Node: Mfcalc Decl,  Next: Mfcalc Rules,  Prev: Multi-function Calc,  Up: Multi-function Calc
  364.  
  365. Declarations for `mfcalc'
  366. -------------------------
  367.  
  368.    Here are the C and Bison declarations for the multi-function
  369. calculator.
  370.  
  371.      %{
  372.      #include <math.h>  /* For math functions, cos(), sin(), etc. */
  373.      #include "calc.h"  /* Contains definition of `symrec'        */
  374.      %}
  375.      %union {
  376.      double     val;  /* For returning numbers.                   */
  377.      symrec  *tptr;   /* For returning symbol-table pointers      */
  378.      }
  379.      
  380.      %token <val>  NUM        /* Simple double precision number   */
  381.      %token <tptr> VAR FNCT   /* Variable and Function            */
  382.      %type  <val>  exp
  383.      
  384.      %right '='
  385.      %left '-' '+'
  386.      %left '*' '/'
  387.      %left NEG     /* Negation--unary minus */
  388.      %right '^'    /* Exponentiation        */
  389.      
  390.      /* Grammar follows */
  391.      
  392.      %%
  393.  
  394.    The above grammar introduces only two new features of the Bison
  395. language. These features allow semantic values to have various data
  396. types (*note Multiple Types::.).
  397.  
  398.    The `%union' declaration specifies the entire list of possible types;
  399. this is instead of defining `YYSTYPE'.  The allowable types are now
  400. double-floats (for `exp' and `NUM') and pointers to entries in the
  401. symbol table.  *Note Union Decl::.
  402.  
  403.    Since values can now have various types, it is necessary to
  404. associate a type with each grammar symbol whose semantic value is used.
  405.  These symbols are `NUM', `VAR', `FNCT', and `exp'.  Their declarations
  406. are augmented with information about their data type (placed between
  407. angle brackets).
  408.  
  409.    The Bison construct `%type' is used for declaring nonterminal
  410. symbols, just as `%token' is used for declaring token types.  We have
  411. not used `%type' before because nonterminal symbols are normally
  412. declared implicitly by the rules that define them.  But `exp' must be
  413. declared explicitly so we can specify its value type.  *Note Type
  414. Decl::.
  415.  
  417. File: bison.info,  Node: Mfcalc Rules,  Next: Mfcalc Symtab,  Prev: Mfcalc Decl,  Up: Multi-function Calc
  418.  
  419. Grammar Rules for `mfcalc'
  420. --------------------------
  421.  
  422.    Here are the grammar rules for the multi-function calculator. Most
  423. of them are copied directly from `calc'; three rules, those which
  424. mention `VAR' or `FNCT', are new.
  425.  
  426.      input:   /* empty */
  427.              | input line
  428.      ;
  429.      
  430.      line:
  431.                '\n'
  432.              | exp '\n'   { printf ("\t%.10g\n", $1); }
  433.              | error '\n' { yyerrok;                  }
  434.      ;
  435.      
  436.      exp:      NUM                { $$ = $1;                         }
  437.              | VAR                { $$ = $1->value.var;              }
  438.              | VAR '=' exp        { $$ = $3; $1->value.var = $3;     }
  439.              | FNCT '(' exp ')'   { $$ = (*($1->value.fnctptr))($3); }
  440.              | exp '+' exp        { $$ = $1 + $3;                    }
  441.              | exp '-' exp        { $$ = $1 - $3;                    }
  442.              | exp '*' exp        { $$ = $1 * $3;                    }
  443.              | exp '/' exp        { $$ = $1 / $3;                    }
  444.              | '-' exp  %prec NEG { $$ = -$2;                        }
  445.              | exp '^' exp        { $$ = pow ($1, $3);               }
  446.              | '(' exp ')'        { $$ = $2;                         }
  447.      ;
  448.      /* End of grammar */
  449.      %%
  450.  
  452. File: bison.info,  Node: Mfcalc Symtab,  Prev: Mfcalc Rules,  Up: Multi-function Calc
  453.  
  454. The `mfcalc' Symbol Table
  455. -------------------------
  456.  
  457.    The multi-function calculator requires a symbol table to keep track
  458. of the names and meanings of variables and functions.  This doesn't
  459. affect the grammar rules (except for the actions) or the Bison
  460. declarations, but it requires some additional C functions for support.
  461.  
  462.    The symbol table itself consists of a linked list of records.  Its
  463. definition, which is kept in the header `calc.h', is as follows.  It
  464. provides for either functions or variables to be placed in the table.
  465.  
  466.      /* Data type for links in the chain of symbols.      */
  467.      struct symrec
  468.      {
  469.        char *name;  /* name of symbol                     */
  470.        int type;    /* type of symbol: either VAR or FNCT */
  471.        union {
  472.          double var;           /* value of a VAR          */
  473.          double (*fnctptr)();  /* value of a FNCT         */
  474.        } value;
  475.        struct symrec *next;    /* link field              */
  476.      };
  477.      
  478.      typedef struct symrec symrec;
  479.      
  480.      /* The symbol table: a chain of `struct symrec'.     */
  481.      extern symrec *sym_table;
  482.      
  483.      symrec *putsym ();
  484.      symrec *getsym ();
  485.  
  486.    The new version of `main' includes a call to `init_table', a
  487. function that initializes the symbol table.  Here it is, and
  488. `init_table' as well:
  489.  
  490.      #include <stdio.h>
  491.      
  492.      main ()
  493.      {
  494.        init_table ();
  495.        yyparse ();
  496.      }
  497.      
  498.      yyerror (s)  /* Called by yyparse on error */
  499.           char *s;
  500.      {
  501.        printf ("%s\n", s);
  502.      }
  503.      
  504.      struct init
  505.      {
  506.        char *fname;
  507.        double (*fnct)();
  508.      };
  509.      
  510.      struct init arith_fncts[]
  511.        = {
  512.            "sin", sin,
  513.            "cos", cos,
  514.            "atan", atan,
  515.            "ln", log,
  516.            "exp", exp,
  517.            "sqrt", sqrt,
  518.            0, 0
  519.          };
  520.      
  521.      /* The symbol table: a chain of `struct symrec'.  */
  522.      symrec *sym_table = (symrec *)0;
  523.      
  524.      init_table ()  /* puts arithmetic functions in table. */
  525.      {
  526.        int i;
  527.        symrec *ptr;
  528.        for (i = 0; arith_fncts[i].fname != 0; i++)
  529.          {
  530.            ptr = putsym (arith_fncts[i].fname, FNCT);
  531.            ptr->value.fnctptr = arith_fncts[i].fnct;
  532.          }
  533.      }
  534.  
  535.    By simply editing the initialization list and adding the necessary
  536. include files, you can add additional functions to the calculator.
  537.  
  538.    Two important functions allow look-up and installation of symbols in
  539. the symbol table.  The function `putsym' is passed a name and the type
  540. (`VAR' or `FNCT') of the object to be installed.  The object is linked
  541. to the front of the list, and a pointer to the object is returned. The
  542. function `getsym' is passed the name of the symbol to look up.  If
  543. found, a pointer to that symbol is returned; otherwise zero is returned.
  544.  
  545.      symrec *
  546.      putsym (sym_name,sym_type)
  547.           char *sym_name;
  548.           int sym_type;
  549.      {
  550.        symrec *ptr;
  551.        ptr = (symrec *) malloc (sizeof (symrec));
  552.        ptr->name = (char *) malloc (strlen (sym_name) + 1);
  553.        strcpy (ptr->name,sym_name);
  554.        ptr->type = sym_type;
  555.        ptr->value.var = 0; /* set value to 0 even if fctn.  */
  556.        ptr->next = (struct symrec *)sym_table;
  557.        sym_table = ptr;
  558.        return ptr;
  559.      }
  560.      
  561.      symrec *
  562.      getsym (sym_name)
  563.           char *sym_name;
  564.      {
  565.        symrec *ptr;
  566.        for (ptr = sym_table; ptr != (symrec *) 0;
  567.             ptr = (symrec *)ptr->next)
  568.          if (strcmp (ptr->name,sym_name) == 0)
  569.            return ptr;
  570.        return 0;
  571.      }
  572.  
  573.    The function `yylex' must now recognize variables, numeric values,
  574. and the single-character arithmetic operators.  Strings of alphanumeric
  575. characters with a leading nondigit are recognized as either variables or
  576. functions depending on what the symbol table says about them.
  577.  
  578.    The string is passed to `getsym' for look up in the symbol table.  If
  579. the name appears in the table, a pointer to its location and its type
  580. (`VAR' or `FNCT') is returned to `yyparse'.  If it is not already in
  581. the table, then it is installed as a `VAR' using `putsym'.  Again, a
  582. pointer and its type (which must be `VAR') is returned to `yyparse'.
  583.  
  584.    No change is needed in the handling of numeric values and arithmetic
  585. operators in `yylex'.
  586.  
  587.      #include <ctype.h>
  588.      yylex ()
  589.      {
  590.        int c;
  591.      
  592.        /* Ignore whitespace, get first nonwhite character.  */
  593.        while ((c = getchar ()) == ' ' || c == '\t');
  594.      
  595.        if (c == EOF)
  596.          return 0;
  597.      
  598.        /* Char starts a number => parse the number.         */
  599.        if (c == '.' || isdigit (c))
  600.          {
  601.            ungetc (c, stdin);
  602.            scanf ("%lf", &yylval.val);
  603.            return NUM;
  604.          }
  605.      
  606.        /* Char starts an identifier => read the name.       */
  607.        if (isalpha (c))
  608.          {
  609.            symrec *s;
  610.            static char *symbuf = 0;
  611.            static int length = 0;
  612.            int i;
  613.      
  614.            /* Initially make the buffer long enough
  615.               for a 40-character symbol name.  */
  616.            if (length == 0)
  617.              length = 40, symbuf = (char *)malloc (length + 1);
  618.      
  619.            i = 0;
  620.            do
  621.              {
  622.                /* If buffer is full, make it bigger.        */
  623.                if (i == length)
  624.                  {
  625.                    length *= 2;
  626.                    symbuf = (char *)realloc (symbuf, length + 1);
  627.                  }
  628.                /* Add this character to the buffer.         */
  629.                symbuf[i++] = c;
  630.                /* Get another character.                    */
  631.                c = getchar ();
  632.              }
  633.            while (c != EOF && isalnum (c));
  634.      
  635.            ungetc (c, stdin);
  636.            symbuf[i] = '\0';
  637.      
  638.            s = getsym (symbuf);
  639.            if (s == 0)
  640.              s = putsym (symbuf, VAR);
  641.            yylval.tptr = s;
  642.            return s->type;
  643.          }
  644.      
  645.        /* Any other character is a token by itself.        */
  646.        return c;
  647.      }
  648.  
  649.    This program is both powerful and flexible. You may easily add new
  650. functions, and it is a simple job to modify this code to install
  651. predefined variables such as `pi' or `e' as well.
  652.  
  654. File: bison.info,  Node: Exercises,  Prev: Multi-function calc,  Up: Examples
  655.  
  656. Exercises
  657. =========
  658.  
  659.   1. Add some new functions from `math.h' to the initialization list.
  660.  
  661.   2. Add another array that contains constants and their values.  Then
  662.      modify `init_table' to add these constants to the symbol table. It
  663.      will be easiest to give the constants type `VAR'.
  664.  
  665.   3. Make the program report an error if the user refers to an
  666.      uninitialized variable in any way except to store a value in it.
  667.  
  669. File: bison.info,  Node: Grammar File,  Next: Interface,  Prev: Examples,  Up: Top
  670.  
  671. Bison Grammar Files
  672. *******************
  673.  
  674.    Bison takes as input a context-free grammar specification and
  675. produces a C-language function that recognizes correct instances of the
  676. grammar.
  677.  
  678.    The Bison grammar input file conventionally has a name ending in
  679. `.y'.
  680.  
  681. * Menu:
  682.  
  683. * Grammar Outline::    Overall layout of the grammar file.
  684. * Symbols::            Terminal and nonterminal symbols.
  685. * Rules::              How to write grammar rules.
  686. * Recursion::          Writing recursive rules.
  687. * Semantics::          Semantic values and actions.
  688. * Declarations::       All kinds of Bison declarations are described here.
  689. * Multiple Parsers::   Putting more than one Bison parser in one program.
  690.  
  692. File: bison.info,  Node: Grammar Outline,  Next: Symbols,  Prev: Grammar File,  Up: Grammar File
  693.  
  694. Outline of a Bison Grammar
  695. ==========================
  696.  
  697.    A Bison grammar file has four main sections, shown here with the
  698. appropriate delimiters:
  699.  
  700.      %{
  701.      C DECLARATIONS
  702.      %}
  703.      
  704.      BISON DECLARATIONS
  705.      
  706.      %%
  707.      GRAMMAR RULES
  708.      %%
  709.      
  710.      ADDITIONAL C CODE
  711.  
  712.    Comments enclosed in `/* ... */' may appear in any of the sections.
  713.  
  714. * Menu:
  715.  
  716. * C Declarations::      Syntax and usage of the C declarations section.
  717. * Bison Declarations::  Syntax and usage of the Bison declarations section.
  718. * Grammar Rules::       Syntax and usage of the grammar rules section.
  719. * C Code::              Syntax and usage of the additional C code section.
  720.  
  722. File: bison.info,  Node: C Declarations,  Next: Bison Declarations,  Prev: Grammar Outline,  Up: Grammar Outline
  723.  
  724. The C Declarations Section
  725. --------------------------
  726.  
  727.    The C DECLARATIONS section contains macro definitions and
  728. declarations of functions and variables that are used in the actions in
  729. the grammar rules.  These are copied to the beginning of the parser
  730. file so that they precede the definition of `yyparse'.  You can use
  731. `#include' to get the declarations from a header file.  If you don't
  732. need any C declarations, you may omit the `%{' and `%}' delimiters that
  733. bracket this section.
  734.  
  736. File: bison.info,  Node: Bison Declarations,  Next: Grammar Rules,  Prev: C Declarations,  Up: Grammar Outline
  737.  
  738. The Bison Declarations Section
  739. ------------------------------
  740.  
  741.    The BISON DECLARATIONS section contains declarations that define
  742. terminal and nonterminal symbols, specify precedence, and so on. In
  743. some simple grammars you may not need any declarations. *Note
  744. Declarations::.
  745.  
  747. File: bison.info,  Node: Grammar Rules,  Next: C Code,  Prev: Bison Declarations,  Up: Grammar Outline
  748.  
  749. The Grammar Rules Section
  750. -------------------------
  751.  
  752.    The "grammar rules" section contains one or more Bison grammar
  753. rules, and nothing else.  *Note Rules::.
  754.  
  755.    There must always be at least one grammar rule, and the first `%%'
  756. (which precedes the grammar rules) may never be omitted even if it is
  757. the first thing in the file.
  758.  
  760. File: bison.info,  Node: C Code,  Prev: Grammar Rules,  Up: Grammar Outline
  761.  
  762. The Additional C Code Section
  763. -----------------------------
  764.  
  765.    The ADDITIONAL C CODE section is copied verbatim to the end of the
  766. parser file, just as the C DECLARATIONS section is copied to the
  767. beginning.  This is the most convenient place to put anything that you
  768. want to have in the parser file but which need not come before the
  769. definition of `yyparse'.  For example, the definitions of `yylex' and
  770. `yyerror' often go here.  *Note Interface::.
  771.  
  772.    If the last section is empty, you may omit the `%%' that separates it
  773. from the grammar rules.
  774.  
  775.    The Bison parser itself contains many static variables whose names
  776. start with `yy' and many macros whose names start with `YY'.  It is a
  777. good idea to avoid using any such names (except those documented in this
  778. manual) in the additional C code section of the grammar file.
  779.  
  781. File: bison.info,  Node: Symbols,  Next: Rules,  Prev: Grammar Outline,  Up: Grammar File
  782.  
  783. Symbols, Terminal and Nonterminal
  784. =================================
  785.  
  786.    "Symbols" in Bison grammars represent the grammatical classifications
  787. of the language.
  788.  
  789.    A "terminal symbol" (also known as a "token type") represents a
  790. class of syntactically equivalent tokens.  You use the symbol in grammar
  791. rules to mean that a token in that class is allowed.  The symbol is
  792. represented in the Bison parser by a numeric code, and the `yylex'
  793. function returns a token type code to indicate what kind of token has
  794. been read.  You don't need to know what the code value is; you can use
  795. the symbol to stand for it.
  796.  
  797.    A "nonterminal symbol" stands for a class of syntactically equivalent
  798. groupings.  The symbol name is used in writing grammar rules.  By
  799. convention, it should be all lower case.
  800.  
  801.    Symbol names can contain letters, digits (not at the beginning),
  802. underscores and periods.  Periods make sense only in nonterminals.
  803.  
  804.    There are two ways of writing terminal symbols in the grammar:
  805.  
  806.    * A "named token type" is written with an identifier, like an
  807.      identifier in C.  By convention, it should be all upper case.  Each
  808.      such name must be defined with a Bison declaration such as
  809.      `%token'.  *Note Token Decl::.
  810.  
  811.    * A "character token type" (or "literal token") is written in the
  812.      grammar using the same syntax used in C for character constants;
  813.      for example, `'+'' is a character token type.  A character token
  814.      type doesn't need to be declared unless you need to specify its
  815.      semantic value data type (*note Value Type::.), associativity, or
  816.      precedence (*note Precedence::.).
  817.  
  818.      By convention, a character token type is used only to represent a
  819.      token that consists of that particular character.  Thus, the token
  820.      type `'+'' is used to represent the character `+' as a token. 
  821.      Nothing enforces this convention, but if you depart from it, your
  822.      program will confuse other readers.
  823.  
  824.      All the usual escape sequences used in character literals in C can
  825.      be used in Bison as well, but you must not use the null character
  826.      as a character literal because its ASCII code, zero, is the code
  827.      `yylex' returns for end-of-input (*note Calling Convention::.).
  828.  
  829.    How you choose to write a terminal symbol has no effect on its
  830. grammatical meaning.  That depends only on where it appears in rules and
  831. on when the parser function returns that symbol.
  832.  
  833.    The value returned by `yylex' is always one of the terminal symbols
  834. (or 0 for end-of-input).  Whichever way you write the token type in the
  835. grammar rules, you write it the same way in the definition of `yylex'.
  836. The numeric code for a character token type is simply the ASCII code for
  837. the character, so `yylex' can use the identical character constant to
  838. generate the requisite code.  Each named token type becomes a C macro in
  839. the parser file, so `yylex' can use the name to stand for the code.
  840. (This is why periods don't make sense in terminal symbols.)  *Note
  841. Calling Convention::.
  842.  
  843.    If `yylex' is defined in a separate file, you need to arrange for the
  844. token-type macro definitions to be available there.  Use the `-d'
  845. option when you run Bison, so that it will write these macro definitions
  846. into a separate header file `NAME.tab.h' which you can include in the
  847. other source files that need it.  *Note Invocation::.
  848.  
  849.    The symbol `error' is a terminal symbol reserved for error recovery
  850. (*note Error Recovery::.); you shouldn't use it for any other purpose.
  851. In particular, `yylex' should never return this value.
  852.  
  854. File: bison.info,  Node: Rules,  Next: Recursion,  Prev: Symbols,  Up: Grammar File
  855.  
  856. Syntax of Grammar Rules
  857. =======================
  858.  
  859.    A Bison grammar rule has the following general form:
  860.  
  861.      RESULT: COMPONENTS...
  862.              ;
  863.  
  864. where RESULT is the nonterminal symbol that this rule describes and
  865. COMPONENTS are various terminal and nonterminal symbols that are put
  866. together by this rule (*note Symbols::.).
  867.  
  868.    For example,
  869.  
  870.      exp:      exp '+' exp
  871.              ;
  872.  
  873. says that two groupings of type `exp', with a `+' token in between, can
  874. be combined into a larger grouping of type `exp'.
  875.  
  876.    Whitespace in rules is significant only to separate symbols.  You
  877. can add extra whitespace as you wish.
  878.  
  879.    Scattered among the components can be ACTIONS that determine the
  880. semantics of the rule.  An action looks like this:
  881.  
  882.      {C STATEMENTS}
  883.  
  884. Usually there is only one action and it follows the components. *Note
  885. Actions::.
  886.  
  887.    Multiple rules for the same RESULT can be written separately or can
  888. be joined with the vertical-bar character `|' as follows:
  889.  
  890.      RESULT:   RULE1-COMPONENTS...
  891.              | RULE2-COMPONENTS...
  892.              ...
  893.              ;
  894.  
  895. They are still considered distinct rules even when joined in this way.
  896.  
  897.    If COMPONENTS in a rule is empty, it means that RESULT can match the
  898. empty string.  For example, here is how to define a comma-separated
  899. sequence of zero or more `exp' groupings:
  900.  
  901.      expseq:   /* empty */
  902.              | expseq1
  903.              ;
  904.      
  905.      expseq1:  exp
  906.              | expseq1 ',' exp
  907.              ;
  908.  
  909. It is customary to write a comment `/* empty */' in each rule with no
  910. components.
  911.  
  913. File: bison.info,  Node: Recursion,  Next: Semantics,  Prev: Rules,  Up: Grammar File
  914.  
  915. Recursive Rules
  916. ===============
  917.  
  918.    A rule is called "recursive" when its RESULT nonterminal appears
  919. also on its right hand side.  Nearly all Bison grammars need to use
  920. recursion, because that is the only way to define a sequence of any
  921. number of somethings.  Consider this recursive definition of a
  922. comma-separated sequence of one or more expressions:
  923.  
  924.      expseq1:  exp
  925.              | expseq1 ',' exp
  926.              ;
  927.  
  928. Since the recursive use of `expseq1' is the leftmost symbol in the
  929. right hand side, we call this "left recursion".  By contrast, here the
  930. same construct is defined using "right recursion":
  931.  
  932.      expseq1:  exp
  933.              | exp ',' expseq1
  934.              ;
  935.  
  936. Any kind of sequence can be defined using either left recursion or
  937. right recursion, but you should always use left recursion, because it
  938. can parse a sequence of any number of elements with bounded stack
  939. space.  Right recursion uses up space on the Bison stack in proportion
  940. to the number of elements in the sequence, because all the elements
  941. must be shifted onto the stack before the rule can be applied even
  942. once.  *Note The Algorithm of the Bison Parser: Algorithm, for further
  943. explanation of this.
  944.  
  945.    "Indirect" or "mutual" recursion occurs when the result of the rule
  946. does not appear directly on its right hand side, but does appear in
  947. rules for other nonterminals which do appear on its right hand side.
  948.  
  949.    For example:
  950.  
  951.      expr:     primary
  952.              | primary '+' primary
  953.              ;
  954.      
  955.      primary:  constant
  956.              | '(' expr ')'
  957.              ;
  958.  
  959. defines two mutually-recursive nonterminals, since each refers to the
  960. other.
  961.  
  963. File: bison.info,  Node: Semantics,  Next: Declarations,  Prev: Recursion,  Up: Grammar File
  964.  
  965. Defining Language Semantics
  966. ===========================
  967.  
  968.    The grammar rules for a language determine only the syntax.  The
  969. semantics are determined by the semantic values associated with various
  970. tokens and groupings, and by the actions taken when various groupings
  971. are recognized.
  972.  
  973.    For example, the calculator calculates properly because the value
  974. associated with each expression is the proper number; it adds properly
  975. because the action for the grouping `X + Y' is to add the numbers
  976. associated with X and Y.
  977.  
  978. * Menu:
  979.  
  980. * Value Type::       Specifying one data type for all semantic values.
  981. * Multiple Types::   Specifying several alternative data types.
  982. * Actions::          An action is the semantic definition of a grammar rule.
  983. * Action Types::     Specifying data types for actions to operate on.
  984. * Mid-Rule Actions:: Most actions go at the end of a rule.
  985.                       This says when, why and how to use the exceptional
  986.                       action in the middle of a rule.
  987.  
  989. File: bison.info,  Node: Value Type,  Next: Multiple Types,  Prev: Semantics,  Up: Semantics
  990.  
  991. Data Types of Semantic Values
  992. -----------------------------
  993.  
  994.    In a simple program it may be sufficient to use the same data type
  995. for the semantic values of all language constructs.  This was true in
  996. the RPN and infix calculator examples (*note RPN Calc::.).
  997.  
  998.    Bison's default is to use type `int' for all semantic values.  To
  999. specify some other type, define `YYSTYPE' as a macro, like this:
  1000.  
  1001.      #define YYSTYPE double
  1002.  
  1003. This macro definition must go in the C declarations section of the
  1004. grammar file (*note Grammar Outline::.).
  1005.  
  1007. File: bison.info,  Node: Multiple Types,  Next: Actions,  Prev: Value Type,  Up: Semantics
  1008.  
  1009. More Than One Value Type
  1010. ------------------------
  1011.  
  1012.    In most programs, you will need different data types for different
  1013. kinds of tokens and groupings.  For example, a numeric constant may
  1014. need type `int' or `long', while a string constant needs type `char *',
  1015. and an identifier might need a pointer to an entry in the symbol table.
  1016.  
  1017.    To use more than one data type for semantic values in one parser,
  1018. Bison requires you to do two things:
  1019.  
  1020.    * Specify the entire collection of possible data types, with the
  1021.      `%union' Bison declaration (*note Union Decl::.).
  1022.  
  1023.    * Choose one of those types for each symbol (terminal or nonterminal)
  1024.      for which semantic values are used.  This is done for tokens with
  1025.      the `%token' Bison declaration (*note Token Decl::.) and for
  1026.      groupings with the `%type' Bison declaration (*note Type Decl::.).
  1027.  
  1029. File: bison.info,  Node: Actions,  Next: Action Types,  Prev: Multiple Types,  Up: Semantics
  1030.  
  1031. Actions
  1032. -------
  1033.  
  1034.    An action accompanies a syntactic rule and contains C code to be
  1035. executed each time an instance of that rule is recognized.  The task of
  1036. most actions is to compute a semantic value for the grouping built by
  1037. the rule from the semantic values associated with tokens or smaller
  1038. groupings.
  1039.  
  1040.    An action consists of C statements surrounded by braces, much like a
  1041. compound statement in C.  It can be placed at any position in the rule;
  1042. it is executed at that position.  Most rules have just one action at
  1043. the end of the rule, following all the components.  Actions in the
  1044. middle of a rule are tricky and used only for special purposes (*note
  1045. Mid-Rule Actions::.).
  1046.  
  1047.    The C code in an action can refer to the semantic values of the
  1048. components matched by the rule with the construct `$N', which stands for
  1049. the value of the Nth component.  The semantic value for the grouping
  1050. being constructed is `$$'.  (Bison translates both of these constructs
  1051. into array element references when it copies the actions into the parser
  1052. file.)
  1053.  
  1054.    Here is a typical example:
  1055.  
  1056.      exp:    ...
  1057.              | exp '+' exp
  1058.                  { $$ = $1 + $3; }
  1059.  
  1060. This rule constructs an `exp' from two smaller `exp' groupings
  1061. connected by a plus-sign token.  In the action, `$1' and `$3' refer to
  1062. the semantic values of the two component `exp' groupings, which are the
  1063. first and third symbols on the right hand side of the rule. The sum is
  1064. stored into `$$' so that it becomes the semantic value of the
  1065. addition-expression just recognized by the rule.  If there were a
  1066. useful semantic value associated with the `+' token, it could be
  1067. referred to as `$2'.
  1068.  
  1069.    `$N' with N zero or negative is allowed for reference to tokens and
  1070. groupings on the stack *before* those that match the current rule. 
  1071. This is a very risky practice, and to use it reliably you must be
  1072. certain of the context in which the rule is applied.  Here is a case in
  1073. which you can use this reliably:
  1074.  
  1075.      foo:      expr bar '+' expr  { ... }
  1076.              | expr bar '-' expr  { ... }
  1077.              ;
  1078.      
  1079.      bar:      /* empty */
  1080.              { previous_expr = $0; }
  1081.              ;
  1082.  
  1083.    As long as `bar' is used only in the fashion shown here, `$0' always
  1084. refers to the `expr' which precedes `bar' in the definition of `foo'.
  1085.  
  1087. File: bison.info,  Node: Action Types,  Next: Mid-Rule Actions,  Prev: Actions,  Up: Semantics
  1088.  
  1089. Data Types of Values in Actions
  1090. -------------------------------
  1091.  
  1092.    If you have chosen a single data type for semantic values, the `$$'
  1093. and `$N' constructs always have that data type.
  1094.  
  1095.    If you have used `%union' to specify a variety of data types, then
  1096. you must declare a choice among these types for each terminal or
  1097. nonterminal symbol that can have a semantic value.  Then each time you
  1098. use `$$' or `$N', its data type is determined by which symbol it refers
  1099. to in the rule.  In this example,
  1100.  
  1101.      exp:    ...
  1102.              | exp '+' exp
  1103.                  { $$ = $1 + $3; }
  1104.  
  1105. `$1' and `$3' refer to instances of `exp', so they all have the data
  1106. type declared for the nonterminal symbol `exp'.  If `$2' were used, it
  1107. would have the data type declared for the terminal symbol `'+'',
  1108. whatever that might be.
  1109.  
  1110.    Alternatively, you can specify the data type when you refer to the
  1111. value, by inserting `<TYPE>' after the `$' at the beginning of the
  1112. reference.  For example, if you have defined types as shown here:
  1113.  
  1114.      %union {
  1115.        int itype;
  1116.        double dtype;
  1117.      }
  1118.  
  1119. then you can write `$<itype>1' to refer to the first subunit of the
  1120. rule as an integer, or `$<dtype>1' to refer to it as a double.
  1121.  
  1123. File: bison.info,  Node: Mid-Rule Actions,  Prev: Action Types,  Up: Semantics
  1124.  
  1125. Actions in Mid-Rule
  1126. -------------------
  1127.  
  1128.    Occasionally it is useful to put an action in the middle of a rule.
  1129. These actions are written just like usual end-of-rule actions, but they
  1130. are executed before the parser even recognizes the following components.
  1131.  
  1132.    A mid-rule action may refer to the components preceding it using
  1133. `$N', but it may not refer to subsequent components because it is run
  1134. before they are parsed.
  1135.  
  1136.    The mid-rule action itself counts as one of the components of the
  1137. rule. This makes a difference when there is another action later in the
  1138. same rule (and usually there is another at the end): you have to count
  1139. the actions along with the symbols when working out which number N to
  1140. use in `$N'.
  1141.  
  1142.    The mid-rule action can also have a semantic value.  This can be set
  1143. within that action by an assignment to `$$', and can referred to by
  1144. actions later in the rule using `$N'.  Since there is no symbol to name
  1145. the action, there is no way to declare a data type for the value in
  1146. advance, so you must use the `$<...>' construct to specify a data type
  1147. each time you refer to this value.
  1148.  
  1149.    There is no way to set the value of the entire rule with a mid-rule
  1150. action, because assignments to `$$' do not have that effect.  The only
  1151. way to set the value for the entire rule is with an ordinary action at
  1152. the end of the rule.
  1153.  
  1154.    Here is an example from a hypothetical compiler, handling a `let'
  1155. statement that looks like `let (VARIABLE) STATEMENT' and serves to
  1156. create a variable named VARIABLE temporarily for the duration of
  1157. STATEMENT.  To parse this construct, we must put VARIABLE into the
  1158. symbol table while STATEMENT is parsed, then remove it afterward.  Here
  1159. is how it is done:
  1160.  
  1161.      stmt:   LET '(' var ')'
  1162.                      { $<context>$ = push_context ();
  1163.                        declare_variable ($3); }
  1164.              stmt    { $$ = $6;
  1165.                        pop_context ($<context>5); }
  1166.  
  1167. As soon as `let (VARIABLE)' has been recognized, the first action is
  1168. run.  It saves a copy of the current semantic context (the list of
  1169. accessible variables) as its semantic value, using alternative
  1170. `context' in the data-type union.  Then it calls `declare_variable' to
  1171. add the new variable to that list.  Once the first action is finished,
  1172. the embedded statement `stmt' can be parsed.  Note that the mid-rule
  1173. action is component number 5, so the `stmt' is component number 6.
  1174.  
  1175.    After the embedded statement is parsed, its semantic value becomes
  1176. the value of the entire `let'-statement.  Then the semantic value from
  1177. the earlier action is used to restore the prior list of variables.  This
  1178. removes the temporary `let'-variable from the list so that it won't
  1179. appear to exist while the rest of the program is parsed.
  1180.  
  1181.    Taking action before a rule is completely recognized often leads to
  1182. conflicts since the parser must commit to a parse in order to execute
  1183. the action.  For example, the following two rules, without mid-rule
  1184. actions, can coexist in a working parser because the parser can shift
  1185. the open-brace token and look at what follows before deciding whether
  1186. there is a declaration or not:
  1187.  
  1188.      compound: '{' declarations statements '}'
  1189.              | '{' statements '}'
  1190.              ;
  1191.  
  1192. But when we add a mid-rule action as follows, the rules become
  1193. nonfunctional:
  1194.  
  1195.      compound: { prepare_for_local_variables (); }
  1196.                '{' declarations statements '}'
  1197.              | '{' statements '}'
  1198.              ;
  1199.  
  1200. Now the parser is forced to decide whether to run the mid-rule action
  1201. when it has read no farther than the open-brace.  In other words, it
  1202. must commit to using one rule or the other, without sufficient
  1203. information to do it correctly.  (The open-brace token is what is called
  1204. the "look-ahead" token at this time, since the parser is still deciding
  1205. what to do about it.  *Note Look-Ahead::.)
  1206.  
  1207.    You might think that you could correct the problem by putting
  1208. identical actions into the two rules, like this:
  1209.  
  1210.      compound: { prepare_for_local_variables (); }
  1211.                '{' declarations statements '}'
  1212.              | { prepare_for_local_variables (); }
  1213.                '{' statements '}'
  1214.              ;
  1215.  
  1216. But this does not help, because Bison does not realize that the two
  1217. actions are identical.  (Bison never tries to understand the C code in
  1218. an action.)
  1219.  
  1220.    If the grammar is such that a declaration can be distinguished from a
  1221. statement by the first token (which is true in C), then one solution
  1222. which does work is to put the action after the open-brace, like this:
  1223.  
  1224.      compound: '{' { prepare_for_local_variables (); }
  1225.                declarations statements '}'
  1226.              | '{' statements '}'
  1227.              ;
  1228.  
  1229. Now the first token of the following declaration or statement, which
  1230. would in any case tell Bison which rule to use, can still do so.
  1231.  
  1232.    Another solution is to bury the action inside a nonterminal symbol
  1233. which serves as a subroutine:
  1234.  
  1235.      subroutine: /* empty */
  1236.                { prepare_for_local_variables (); }
  1237.              ;
  1238.      
  1239.      compound: subroutine
  1240.                '{' declarations statements '}'
  1241.              | subroutine
  1242.                '{' statements '}'
  1243.              ;
  1244.  
  1245. Now Bison can execute the action in the rule for `subroutine' without
  1246. deciding which rule for `compound' it will eventually use.  Note that
  1247. the action is now at the end of its rule.  Any mid-rule action can be
  1248. converted to an end-of-rule action in this way, and this is what Bison
  1249. actually does to implement mid-rule actions.
  1250.  
  1252. File: bison.info,  Node: Declarations,  Next: Multiple Parsers,  Prev: Semantics,  Up: Grammar File
  1253.  
  1254. Bison Declarations
  1255. ==================
  1256.  
  1257.    The "Bison declarations" section of a Bison grammar defines the
  1258. symbols used in formulating the grammar and the data types of semantic
  1259. values. *Note Symbols::.
  1260.  
  1261.    All token type names (but not single-character literal tokens such as
  1262. `'+'' and `'*'') must be declared.  Nonterminal symbols must be
  1263. declared if you need to specify which data type to use for the semantic
  1264. value (*note Multiple Types::.).
  1265.  
  1266.    The first rule in the file also specifies the start symbol, by
  1267. default. If you want some other symbol to be the start symbol, you must
  1268. declare it explicitly (*note Language and Grammar::.).
  1269.  
  1270. * Menu:
  1271.  
  1272. * Token Decl::       Declaring terminal symbols.
  1273. * Precedence Decl::  Declaring terminals with precedence and associativity.
  1274. * Union Decl::       Declaring the set of all semantic value types.
  1275. * Type Decl::        Declaring the choice of type for a nonterminal symbol.
  1276. * Expect Decl::      Suppressing warnings about shift/reduce conflicts.
  1277. * Start Decl::       Specifying the start symbol.
  1278. * Pure Decl::        Requesting a reentrant parser.
  1279. * Decl Summary::     Table of all Bison declarations.
  1280.  
  1282. File: bison.info,  Node: Token Decl,  Next: Precedence Decl,  Prev: Declarations,  Up: Declarations
  1283.  
  1284. Token Type Names
  1285. ----------------
  1286.  
  1287.    The basic way to declare a token type name (terminal symbol) is as
  1288. follows:
  1289.  
  1290.      %token NAME
  1291.  
  1292.    Bison will convert this into a `#define' directive in the parser, so
  1293. that the function `yylex' (if it is in this file) can use the name NAME
  1294. to stand for this token type's code.
  1295.  
  1296.    Alternatively you can use `%left', `%right', or `%nonassoc' instead
  1297. of `%token', if you wish to specify precedence. *Note Precedence Decl::.
  1298.  
  1299.    You can explicitly specify the numeric code for a token type by
  1300. appending an integer value in the field immediately following the token
  1301. name:
  1302.  
  1303.      %token NUM 300
  1304.  
  1305. It is generally best, however, to let Bison choose the numeric codes for
  1306. all token types.  Bison will automatically select codes that don't
  1307. conflict with each other or with ASCII characters.
  1308.  
  1309.    In the event that the stack type is a union, you must augment the
  1310. `%token' or other token declaration to include the data type
  1311. alternative delimited by angle-brackets (*note Multiple Types::.).
  1312.  
  1313.    For example:
  1314.  
  1315.      %union {              /* define stack type */
  1316.        double val;
  1317.        symrec *tptr;
  1318.      }
  1319.      %token <val> NUM      /* define token NUM and its type */
  1320.  
  1322. File: bison.info,  Node: Precedence Decl,  Next: Union Decl,  Prev: Token Decl,  Up: Declarations
  1323.  
  1324. Operator Precedence
  1325. -------------------
  1326.  
  1327.    Use the `%left', `%right' or `%nonassoc' declaration to declare a
  1328. token and specify its precedence and associativity, all at once.  These
  1329. are called "precedence declarations". *Note Precedence::, for general
  1330. information on operator precedence.
  1331.  
  1332.    The syntax of a precedence declaration is the same as that of
  1333. `%token': either
  1334.  
  1335.      %left SYMBOLS...
  1336.  
  1337. or
  1338.  
  1339.      %left <TYPE> SYMBOLS...
  1340.  
  1341.    And indeed any of these declarations serves the purposes of `%token'.
  1342. But in addition, they specify the associativity and relative precedence
  1343. for all the SYMBOLS:
  1344.  
  1345.    * The associativity of an operator OP determines how repeated uses
  1346.      of the operator nest: whether `X OP Y OP Z' is parsed by grouping
  1347.      X with Y first or by grouping Y with Z first.  `%left' specifies
  1348.      left-associativity (grouping X with Y first) and `%right'
  1349.      specifies right-associativity (grouping Y with Z first). 
  1350.      `%nonassoc' specifies no associativity, which means that `X OP Y
  1351.      OP Z' is considered a syntax error.
  1352.  
  1353.    * The precedence of an operator determines how it nests with other
  1354.      operators. All the tokens declared in a single precedence
  1355.      declaration have equal precedence and nest together according to
  1356.      their associativity. When two tokens declared in different
  1357.      precedence declarations associate, the one declared later has the
  1358.      higher precedence and is grouped first.
  1359.  
  1361. File: bison.info,  Node: Union Decl,  Next: Type Decl,  Prev: Precedence Decl,  Up: Declarations
  1362.  
  1363. The Collection of Value Types
  1364. -----------------------------
  1365.  
  1366.    The `%union' declaration specifies the entire collection of possible
  1367. data types for semantic values.  The keyword `%union' is followed by a
  1368. pair of braces containing the same thing that goes inside a `union' in
  1369. C.
  1370.  
  1371.    For example:
  1372.  
  1373.      %union {
  1374.        double val;
  1375.        symrec *tptr;
  1376.      }
  1377.  
  1378. This says that the two alternative types are `double' and `symrec *'. 
  1379. They are given names `val' and `tptr'; these names are used in the
  1380. `%token' and `%type' declarations to pick one of the types for a
  1381. terminal or nonterminal symbol (*note Type Decl::.).
  1382.  
  1383.    Note that, unlike making a `union' declaration in C, you do not write
  1384. a semicolon after the closing brace.
  1385.